Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[receiver/sshcheck] Include SSH endpoint resource attribute #24676

Merged
merged 7 commits into from
Aug 1, 2023
Merged

[receiver/sshcheck] Include SSH endpoint resource attribute #24676

merged 7 commits into from
Aug 1, 2023

Conversation

DewaldDeJager
Copy link
Contributor

Description: The metadata.yml for the SSH check receiver currently documents a resource attribute containing the SSH endpoint but this is not emitted. This PR updates the receiver to include this resource attribute.

Link to tracking Issue: #24441

Testing:

Example collector config:

receivers:
  sshcheck:
    endpoint: 13.245.150.131:22
    username: ec2-user
    key_file: /Users/dewald.dejager/.ssh/sandbox.pem
    collection_interval: 15s
    known_hosts: /Users/dewald.dejager/.ssh/known_hosts
    ignore_host_key: false
    resource_attributes:
      "ssh.endpoint":
        enabled: true

exporters:
  logging:
    verbosity: detailed
  prometheus:
    endpoint: 0.0.0.0:8081
    resource_to_telemetry_conversion:
      enabled: true

service:
  pipelines:
    metrics:
      receivers: [sshcheck]
      exporters: [logging, prometheus]

The log output looks like this:

2023-07-30T16:52:38.724+0200    info    MetricsExporter {"kind": "exporter", "data_type": "metrics", "name": "logging", "resource metrics": 1, "metrics": 2, "data points": 2}
2023-07-30T16:52:38.724+0200    info    ResourceMetrics #0
Resource SchemaURL: 
Resource attributes:
     -> ssh.endpoint: Str(13.245.150.131:22)
ScopeMetrics #0
ScopeMetrics SchemaURL: 
InstrumentationScope otelcol/sshcheckreceiver 0.82.0-dev
Metric #0
Descriptor:
     -> Name: sshcheck.duration
     -> Description: Measures the duration of SSH connection.
     -> Unit: ms
     -> DataType: Gauge
NumberDataPoints #0
StartTimestamp: 2023-07-30 14:52:22.381672 +0000 UTC
Timestamp: 2023-07-30 14:52:38.404003 +0000 UTC
Value: 319
Metric #1
Descriptor:
     -> Name: sshcheck.status
     -> Description: 1 if the SSH client successfully connected, otherwise 0.
     -> Unit: 1
     -> DataType: Sum
     -> IsMonotonic: false
     -> AggregationTemporality: Cumulative
NumberDataPoints #0
StartTimestamp: 2023-07-30 14:52:22.381672 +0000 UTC
Timestamp: 2023-07-30 14:52:38.404003 +0000 UTC
Value: 1

And the Prometheus metrics look like this:

# HELP sshcheck_duration Measures the duration of SSH connection.
# TYPE sshcheck_duration gauge
sshcheck_duration{ssh_endpoint="13.245.150.131:22"} 311
# HELP sshcheck_status 1 if the SSH client successfully connected, otherwise 0.
# TYPE sshcheck_status gauge
sshcheck_status{ssh_endpoint="13.245.150.131:22"} 1

@DewaldDeJager DewaldDeJager requested a review from a team July 30, 2023 14:59
@DewaldDeJager DewaldDeJager requested a review from codeboten as a code owner July 30, 2023 14:59
@github-actions github-actions bot requested a review from nslaughter July 30, 2023 14:59
@DewaldDeJager
Copy link
Contributor Author

The failing test is unrelated to the changes in this PR. Looks like a K8s scheduling/resourcing issue. Please would you trigger a re-run of the failing check?

@atoulme
Copy link
Contributor

atoulme commented Jul 31, 2023

Done.

@DewaldDeJager
Add test to check that resource attribute is propagated to metrics
4a7ee85 
Add test to check that resource attribute is propagated to metrics


Revert the change to the test config file
@DewaldDeJager
Merge remote-tracking branch 'origin/feature/emitSshEndpointResourceA…
46e4506 
…ttribute' into feature/emitSshEndpointResourceAttribute
@DewaldDeJager DewaldDeJager mentioned this pull request Jul 31, 2023
Closed
@DewaldDeJager
Copy link
Contributor Author

One of the lint matrix checks is failing because of a timeout. I don't think it's related to these changes. Please could you re-run that check?

@dmitryax dmitryax merged commit 753c593 into open-telemetry:main Aug 1, 2023
@github-actions github-actions bot added this to the next release milestone Aug 1, 2023
@DewaldDeJager DewaldDeJager deleted the feature/emitSshEndpointResourceAttribute branch August 1, 2023 06:01
@dmitryax dmitryax mentioned this pull request Aug 6, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dmitryax dmitryax dmitryax approved these changes

@atoulme atoulme atoulme approved these changes

@codeboten codeboten Awaiting requested review from codeboten

@nslaughter nslaughter Awaiting requested review from nslaughter

Assignees

@jpkrohling jpkrohling

Labels
receiver/sshcheck
Projects
None yet
Milestone
v0.83.0
Development

Successfully merging this pull request may close these issues.
4 participants
@DewaldDeJager @atoulme @dmitryax @jpkrohling